12 parcelas

Segurança

Para acessar a API, é necessário obter um token de acesso através do fluxo de autenticação OAuth2. Veja mais detalhes em Como obter acesso?

info

Ao gerar o token JWT, não esqueça de utilizar o escopo correto. Caso contrário, a requisição será rejeitada com o código de erro 401 Unauthorized.

Descrição dos campos

Campo	Tipo	Descrição
payment	number	Valor do pagamento
loan_amount	number	Valor do empréstimo
number_of_payments	number	Número de parcelas

Requisição

POST https://api-sandbox.catalisa.com.br/calc-engine/api/loan-interest-rate-calculator/calculations JWT scope: calculations-engine/calculate

Parâmetros

Sem parâmetros

Cabeçalhos

Nome	Valor
Authorization	Bearer <token>
Content-Type	application/json

Exemplo de Requisição

Corpo da Requisição

{
  "data": {
    "type": "calculations",
    "attributes": {
      "payment": 1200.0,
      "number_of_payments": 12,
      "loan_amount": 10000.0
    }
  }
}

Respostas

Código	Descrição
201	Criado com sucesso. Retorna os dados da tabela de amortização.
401	Não autorizado

Exemplo de uso

Javascript

const headers = new Headers();
headers.append("Authorization", "Bearer <token>");
headers.append("Content-Type", "application/json");

const body = JSON.stringify({
  data: {
    type: "calculations",
    attributes: {
      payment: 1200.0,
      number_of_payments: 12,
      loan_amount: 10000.0
    }
  }
});

const requestOptions = {
  method: "POST",
  headers: headers,
  body: body,
};

const response = await fetch(
  "https://api-sandbox.catalisa.com.br/calc-engine/api/loan-interest-rate-calculator/calculations",
  requestOptions
);
const data = await response.json();
console.log(data);

CURL

curl --location 'https://api-sandbox.catalisa.com.br/calc-engine/api/loan-interest-rate-calculator/calculations' \
--header 'Authorization: Bearer <token>' \
--data '{
  "data": {
    "type": "calculations",
    "attributes": {
      "payment": 1200.0,
      "number_of_payments": 12,
      "loan_amount": 10000.0
    }
  }
}'

Exemplo de Sucesso

{
  "data": {
    "id": "c5dd7b24-46f3-4717-a5fa-9d586ba748ee",
    "type": "calculations",
    "attributes": {
      "rounded_interest_rate": 0.0611,
      "high_precision_interest_rate": 0.06110398953
    }
  }
}